Mappedin Android SDK/com.mappedin.sdk.managers/MPICameraManager

MPICameraManager

class MPICameraManager

A camera controls manager.

This class encapsulates the methods that manipulate the camera.

Constructors

MPICameraManager

constructor()

Creates a MPICameraManager.

Properties

var listener: MPICameraListener?

an instance of MPICameraListener

var position: MPIMap.MPICoordinate?

var rotation: Double

the current camera rotation of MPIMapView.

var safeAreaInsets: MPIOptions.CameraSetSafeAreaInsets

var tilt: Double

the current camera tilt of MPIMapView.

var zoom: Double

Functions

fun animate( config: MPIOptions.CameraTransformCoordinate, options: MPIOptions.CameraAnimation? = null, callback: (error: MPIError?) -> Unit? = null)

Animate the Camera's view to smoothly transition to a new state over time, using a coordinate.

fun animate(config: MPIOptions.CameraTransformNode, options: MPIOptions.CameraAnimation? = null, callback: (error: MPIError?) -> Unit? = null)

Animate the Camera's view to smoothly transition to a new state over time, using a node.

disableInteractions

fun disableInteractions()

Disables user camera interactions.

enableInteractions

fun enableInteractions()

Enables user camera interactions.

fun focusOn(targets: MPIOptions.CameraTargets, options: MPIOptions.FocusOn? = null, callback: (error: MPIError?) -> Unit? = null)

Focus the Camera view on a collection of targets and animate to that state.

fun set(positionOptions: MPIOptions.CameraTransformCoordinate, callback: (error: MPIError?) -> Unit? = null)

Set the Camera's view to a new state using a coordinate.

fun set(positionOptions: MPIOptions.CameraTransformNode, callback: (error: MPIError?) -> Unit? = null)

Set the Camera's view to a new state using a node.

setCameraInteractions

fun setCameraInteractions(options: MPIOptions.CameraInteractionsSetOptions)

Enable or disable the ability for the user to interact with the camera (e.g. pan, zoom, tilt, etc). This does not affect programmatic camera controls, such as set and focusOn.

fun setMaxTilt(tiltAngle: Double, callback: (MPIError?) -> Unit?)

Sets the maximum tilt of MPIMapView, in radians

fun setMaxZoom(zoomLevel: Double)

Sets the maximum zoom level of MPIMapView

fun setMinZoom(zoomLevel: Double)

Sets the minimum zoom level of MPIMapView

suspend fun setRotation(rotation: Double): Double

fun ~~setRotation~~(rotation: Double, callback: (MPIError?) -> Unit?)

Sets the current camera rotation of MPIMapView

setSafeAreaInsets

fun setSafeAreaInsets(safeAreaInsets: MPIOptions.CameraSetSafeAreaInsets)

Define an area of the screen that is safe or unobscured for the camera. Anything outside the safe area is assumed to be covered in some way (e.g. by UI) meaning the camera will not place focus on elements in that area.

suspend fun setTilt(tilt: Double): Double

fun ~~setTilt~~(tilt: Double, callback: (MPIError?) -> Unit?)

Sets the current camera tilt of MPIMapView

suspend fun setZoom(zoom: Double): Double

fun ~~setZoom~~(zoom: Double, callback: (MPIError?) -> Unit? = null)

Sets the current zoom level of MPIMapView

fun translate( direction: MPIOptions.CAMERA_DIRECTION, distance: Double, options: MPIOptions.CameraAnimation? = null, callback: (error: MPIError?) -> Unit? = null)

Moves the Camera view in a relative direction by a given distance in meters.